Add Harbor/Artificatory documentation to Helm Air Gap docs #2791
Conversation
pandemicsyn
added
type::feature
type::docs
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
docs/vendor/helm-install-airgap.mdx
Outdated
|
|
||
| Connecting the Replicated proxy registry with Harbor and Artifactory has the following limitations: | ||
|
|
||
| * Neither the catalog or tags listing endpoints respect pagination requests yet but harbor requests 1000 items at a time. (Documented in "Harbor _catalog use": https://docs.google.com/document/d/1Ece7PaFOV12EVhMWFMHkrVZLDHFQfWUv4rWzi_wRjAM/edit#heading=h.wxiwuxpqb3pw) |
There was a problem hiding this comment.
@paigecalvert thats our internal google doc. The harbor page size isn't documented anymore other than code - so not sure its worth linking too since it could change at any time.
But https://github.com/goharbor/harbor/blob/9e55afbb9a124dbe47562d56769ad4e9f14cb5ed/src/pkg/registry/client.go#L705 is the permalink for the current harbor version where this is set.
|
|
||
| * Neither the catalog or tags listing endpoints exposed by the Replicated proxy service respect pagination requests. However, Harbor requests 1000 items at a time. | ||
|
|
||
| * Only authenticated users can perform catalog calls or list tags. Authenticated users are those with an email address and license ID associated with a customer in the Vendor Portal. |
There was a problem hiding this comment.
Authenticated users are those with an email address and license ID associated with a customer in the Vendor Portal.
Just put this down as a guess. Not sure if it's worth clarifying what we mean by "authenticated user"
|
|
||
| 1. (Optional) Add a pull-based replication rule to support image mirroring. See [Configure Image Mirroring in Harbor](#harbor-mirror) below. | ||
|
|
||
| ### Configure Image Mirroring in Harbor {#harbor-mirror} |
There was a problem hiding this comment.
^ Moved this to its own subsection
| @@ -0,0 +1,72 @@ | |||
| # Using a Registry Proxy for Helm Air Gap Installations (Alpha) | |||
There was a problem hiding this comment.
Left "for Helm Air Gap Installations" in the title since it sounds like that is the main use case this is intending to server for now. I figure we could always expand and move this topic as the scope of likely use cases grows, but lmk if that makes sense to you
On that note, not sure if "Alpha" is an appropriate label here
There was a problem hiding this comment.
think its fine, our main Helm Air Gap doc flags as being alpha too and this is probably also just the first pass for this bit (hence things like us not respecting pagination requests yet).
pandemicsyn
deleted the
florianhines/sc-114300/download-portal-should-allow-enterprises
branch
Add's high level doc's around using Harbor and Artifactory to the Helm Air Gap docs.
https://deploy-preview-2791--replicated-docs-upgrade.netlify.app/vendor/helm-install-airgap#pull-through-registry-proxies-and-mirrorsEdit from Paige: Moved this content to a new topic here https://deploy-preview-2791--replicated-docs.netlify.app/vendor/using-third-party-registry-proxy